Document various Garmin-specific options.
authorrobertl <robertl>
Tue, 6 Jun 2006 21:36:06 +0000 (21:36 +0000)
committerrobertl <robertl>
Tue, 6 Jun 2006 21:36:06 +0000 (21:36 +0000)
xmldoc/formats/options/garmin-category.xml
xmldoc/formats/options/garmin-deficon.xml
xmldoc/formats/options/garmin-get_posn.xml
xmldoc/formats/options/garmin-power_off.xml
xmldoc/formats/options/garmin-snlen.xml
xmldoc/formats/options/garmin-snwhite.xml

index 8b137891791fe96927ad78e64b0aad7bded08bdc..83ed08f2cd1d2b02dc65ed41d90c8e47d2cae44f 100644 (file)
@@ -1 +1,3 @@
-
+<para>This numeric option will force waypoints to be written with that
+category number when sending to a Garmin receiver that has category
+support. It is ignored on receivers without that capability. </para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..26ff03d893ddf7e86c631a2e640a0885ad5f182f 100644 (file)
@@ -1 +1,17 @@
+<para>
+This option specifies the icon or waypoint type to write for each waypoint on
+output.
+</para>
+<para>
+If this option is specified, its value will be used for all waypoints, not
+just those that do not already have descriptions.  That is, this option
+overrides any icon description that might be in the input file.
+</para>
+<para>
+Value specified may be a number from the Garmin Protocol Spec or a name
+as described in the <xref linkend="GarminIcons"></xref>.
+</para>
+<para>
+This option has no effect on input.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..f4d49e18e3eaeba468c829f8827abbe62dd055ee 100644 (file)
@@ -1 +1,5 @@
-
+<para>This options gets the current position from the attached GPS device
+and returns it as a single waypoint for further processing.  For example,
+to return the current position from a USB Garmin to a KML file:
+<screen format="linespecific">gpsbabel -i garmin -f usb: -o kml -F myposition.kml</screen>
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..63c22850d02fad929b38b218a65705a3a8de7005 100644 (file)
@@ -1 +1,8 @@
+<para>This command forces an immediate powerdown of the addressed Garmin
+receiver.  It is ignored on hardware that does not support this command.
+Obviously, further processing once you have sent a "power off" command to
+a unit that supports it is rather futile, so place this option carefully
+in your command.
 
+<screen format="linespecific">gpsbabel -o garmin,power_off -F /dev/ttyS0</screen>
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..3aa721c67be581eac32fa04df69506485acb151d 100644 (file)
@@ -1 +1,7 @@
-
+<para>This option overrides the internal logic to figure out how many
+characters an addressed Garmin GPS will support when using the '-s' smartname
+option.   This should be necessary only if you have a receiver type that
+GPSBabel doesn't know about or if you want to "dumb down" one unit to match
+another, such as wanting waypoint names in a StreetPilot 2720 (which supports
+20 character names) to exactly match those in a 60CS (which supports 10).
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..8a2f1987a5e04ea91c06b192f3fe018587f992ac 100644 (file)
@@ -1 +1,2 @@
-
+<para>This options controls whether spaces are allowed in generated 
+smart names when using the '-s' option.</para>